<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilasu: XAsu_HmacParams Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilasu
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_x_asu___hmac_params.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XAsu_HmacParams Struct Reference<div class="ingroups"><a class="el" href="group__xasu__common__defs.html">Common Defs</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>This structure contains HMAC params info.
 <a href="struct_x_asu___hmac_params.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a88cff332a0caa94bdd7f7951243b8235"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_asu___hmac_params.html#a88cff332a0caa94bdd7f7951243b8235">ShaType</a></td></tr>
<tr class="memdesc:a88cff332a0caa94bdd7f7951243b8235"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hash family type (XASU_SHA2_TYPE / XASU_SHA3_TYPE)  <a href="#a88cff332a0caa94bdd7f7951243b8235">More...</a><br/></td></tr>
<tr class="separator:a88cff332a0caa94bdd7f7951243b8235"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ac844d8a769624d98bbd4a1403d60f2"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_asu___hmac_params.html#a1ac844d8a769624d98bbd4a1403d60f2">ShaMode</a></td></tr>
<tr class="memdesc:a1ac844d8a769624d98bbd4a1403d60f2"><td class="mdescLeft">&#160;</td><td class="mdescRight"><pre class="fragment">   SHA Mode, where XASU_SHA_MODE_SHAKE256 is valid only for SHA3 Type
</pre><p> (XASU_SHA_MODE_SHA256 / XASU_SHA_MODE_SHA384 / XASU_SHA_MODE_SHA512 / XASU_SHA_MODE_SHAKE256)  <a href="#a1ac844d8a769624d98bbd4a1403d60f2">More...</a><br/></td></tr>
<tr class="separator:a1ac844d8a769624d98bbd4a1403d60f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ed434b3d836170df4b69125ed09f29a"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_asu___hmac_params.html#a8ed434b3d836170df4b69125ed09f29a">IsLast</a></td></tr>
<tr class="memdesc:a8ed434b3d836170df4b69125ed09f29a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether it is the last update of data to HMAC.  <a href="#a8ed434b3d836170df4b69125ed09f29a">More...</a><br/></td></tr>
<tr class="separator:a8ed434b3d836170df4b69125ed09f29a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af681757f8d870f564596fbcaccc1de81"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_asu___hmac_params.html#af681757f8d870f564596fbcaccc1de81">OperationFlags</a></td></tr>
<tr class="memdesc:af681757f8d870f564596fbcaccc1de81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags that determine the operation type.  <a href="#af681757f8d870f564596fbcaccc1de81">More...</a><br/></td></tr>
<tr class="separator:af681757f8d870f564596fbcaccc1de81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af17017d7f9c96982d643723840073597"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_asu___hmac_params.html#af17017d7f9c96982d643723840073597">KeyLen</a></td></tr>
<tr class="memdesc:af17017d7f9c96982d643723840073597"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length of the key.  <a href="#af17017d7f9c96982d643723840073597">More...</a><br/></td></tr>
<tr class="separator:af17017d7f9c96982d643723840073597"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7c9b754f239713e21a41d6f61b1e61b"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_asu___hmac_params.html#af7c9b754f239713e21a41d6f61b1e61b">MsgLen</a></td></tr>
<tr class="memdesc:af7c9b754f239713e21a41d6f61b1e61b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length of the message to be processed.  <a href="#af7c9b754f239713e21a41d6f61b1e61b">More...</a><br/></td></tr>
<tr class="separator:af7c9b754f239713e21a41d6f61b1e61b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b51dbfd52ff462a642848d0d2150c14"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_asu___hmac_params.html#a8b51dbfd52ff462a642848d0d2150c14">HmacLen</a></td></tr>
<tr class="memdesc:a8b51dbfd52ff462a642848d0d2150c14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length of the HMAC to be generated.  <a href="#a8b51dbfd52ff462a642848d0d2150c14">More...</a><br/></td></tr>
<tr class="separator:a8b51dbfd52ff462a642848d0d2150c14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae28c54d873fb17cd63543ea7e077db7e"><td class="memItemLeft" align="right" valign="top">u64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_asu___hmac_params.html#ae28c54d873fb17cd63543ea7e077db7e">KeyAddr</a></td></tr>
<tr class="memdesc:ae28c54d873fb17cd63543ea7e077db7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Key address.  <a href="#ae28c54d873fb17cd63543ea7e077db7e">More...</a><br/></td></tr>
<tr class="separator:ae28c54d873fb17cd63543ea7e077db7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8651415dc1db7c9bdbbc0f328a379d67"><td class="memItemLeft" align="right" valign="top">u64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_asu___hmac_params.html#a8651415dc1db7c9bdbbc0f328a379d67">MsgBufferAddr</a></td></tr>
<tr class="memdesc:a8651415dc1db7c9bdbbc0f328a379d67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Address of the message buffer.  <a href="#a8651415dc1db7c9bdbbc0f328a379d67">More...</a><br/></td></tr>
<tr class="separator:a8651415dc1db7c9bdbbc0f328a379d67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a852eebbd400e71ec9f3e384bf4258151"><td class="memItemLeft" align="right" valign="top">u64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_asu___hmac_params.html#a852eebbd400e71ec9f3e384bf4258151">HmacAddr</a></td></tr>
<tr class="memdesc:a852eebbd400e71ec9f3e384bf4258151"><td class="mdescLeft">&#160;</td><td class="mdescRight">Address of the output buffer to store the generated HMAC.  <a href="#a852eebbd400e71ec9f3e384bf4258151">More...</a><br/></td></tr>
<tr class="separator:a852eebbd400e71ec9f3e384bf4258151"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This structure contains HMAC params info. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a852eebbd400e71ec9f3e384bf4258151"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u64 XAsu_HmacParams::HmacAddr</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Address of the output buffer to store the generated HMAC. </p>

<p>Referenced by <a class="el" href="group__xasu__hmac__client__apis.html#ga4a51b82f829ed68f456efc5d0fb30a8c">XAsu_HmacCompute()</a>.</p>

</div>
</div>
<a class="anchor" id="a8b51dbfd52ff462a642848d0d2150c14"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XAsu_HmacParams::HmacLen</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Length of the HMAC to be generated. </p>

<p>Referenced by <a class="el" href="group__xasu__hmac__client__apis.html#ga4a51b82f829ed68f456efc5d0fb30a8c">XAsu_HmacCompute()</a>.</p>

</div>
</div>
<a class="anchor" id="a8ed434b3d836170df4b69125ed09f29a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAsu_HmacParams::IsLast</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Indicates whether it is the last update of data to HMAC. </p>
<ul>
<li>FALSE: Not Last update.</li>
<li>TRUE: Last update. </li>
</ul>

</div>
</div>
<a class="anchor" id="ae28c54d873fb17cd63543ea7e077db7e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u64 XAsu_HmacParams::KeyAddr</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Key address. </p>

</div>
</div>
<a class="anchor" id="af17017d7f9c96982d643723840073597"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XAsu_HmacParams::KeyLen</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Length of the key. </p>

</div>
</div>
<a class="anchor" id="a8651415dc1db7c9bdbbc0f328a379d67"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u64 XAsu_HmacParams::MsgBufferAddr</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Address of the message buffer. </p>

</div>
</div>
<a class="anchor" id="af7c9b754f239713e21a41d6f61b1e61b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XAsu_HmacParams::MsgLen</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Length of the message to be processed. </p>
<p>MsgLen can be 0 &lt;= MsgLen &lt; ((2^B)-8B). Where B is the block length of the selected SHA type and SHA mode. </p>

</div>
</div>
<a class="anchor" id="af681757f8d870f564596fbcaccc1de81"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAsu_HmacParams::OperationFlags</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Flags that determine the operation type. </p>
<p>These can be a combination of XASU_HMAC_INIT, XASU_HMAC_UPDATE and XASU_HMAC_FINAL </p>

<p>Referenced by <a class="el" href="group__xasu__hmac__client__apis.html#ga4a51b82f829ed68f456efc5d0fb30a8c">XAsu_HmacCompute()</a>.</p>

</div>
</div>
<a class="anchor" id="a1ac844d8a769624d98bbd4a1403d60f2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAsu_HmacParams::ShaMode</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><pre class="fragment">   SHA Mode, where XASU_SHA_MODE_SHAKE256 is valid only for SHA3 Type
</pre><p> (XASU_SHA_MODE_SHA256 / XASU_SHA_MODE_SHA384 / XASU_SHA_MODE_SHA512 / XASU_SHA_MODE_SHAKE256) </p>

</div>
</div>
<a class="anchor" id="a88cff332a0caa94bdd7f7951243b8235"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAsu_HmacParams::ShaType</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Hash family type (XASU_SHA2_TYPE / XASU_SHA3_TYPE) </p>

<p>Referenced by <a class="el" href="group__xasu__hmac__client__apis.html#ga4a51b82f829ed68f456efc5d0fb30a8c">XAsu_HmacCompute()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
